tf-azurerm-module_collection-spoke_network

Overview

This module

• Creates the standard names for the resources to be deployed
• Creates
  • Resource group for the VNET and related resource's
  • Virtual network to be treated as spoke virtual network
  • Subnet/s associated with virtual network
  • Network security group/s to be associated with each subnet
  • Network security group rule/s to be associated with each network security group
  • Route table/s to be associated with each subnet
  • Route table rule/s to be associated with each route table

Pre-Commit hooks

.pre-commit-config.yaml file defines certain pre-commit hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.

commitlint hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:

• fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
• feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
• BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
• build: a commit of the type build adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• chore: a commit of the type chore adds changes that don't modify src or test files
• ci: a commit of the type ci adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: a commit of the type docs adds documentation only changes
• perf: a commit of the type perf adds code change that improves performance
• refactor: a commit of the type refactor adds code change that neither fixes a bug nor adds a feature
• revert: a commit of the type revert reverts a previous commit
• style: a commit of the type style adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: a commit of the type test adds missing tests or correcting existing tests

Base configuration used for this project is commitlint-config-conventional (based on the Angular convention)

If you are a developer using vscode, this plugin may be helpful.

detect-secrets-hook prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS

In order for pre-commit hooks to work properly

• You need to have the pre-commit package manager installed. Here are the installation instructions.
• pre-commit would install all the hooks when commit message is added by default except for commitlint hook. commitlint hook would need to be installed manually using the command below

pre-commit install --hook-type commit-msg

To test the resource group module locally

1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the configure target in the project's Makefile. Before you can run configure, familiarize yourself with the variables in the Makefile and ensure they're pointing to the right places.

make configure

This adds in several files and directories that are ignored by git. They expose many new Make targets.

2. THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP. The first target you care about is env. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.

make configure command will bring down azure_env.sh file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.

These environment variables are used by terratest integration suit.

Service principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.

"Microsoft.Resources/subscriptions/resourceGroups/write"
"Microsoft.Resources/subscriptions/resourceGroups/read"
"Microsoft.Resources/subscriptions/resourceGroups/delete"

Then run this make target to set the environment variables on developer workstation.

make env

3. The first target you care about is check.

Pre-requisites Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are azure specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.

• A file named provider.tf with contents below

provider "azurerm" {
  features {}
}

• A file named terraform.tfvars which contains key value pair of variables used.

Note that since these files are added in gitignore they would not be checked in into primitive/segment's git repo.

After creating these files, for running tests associated with the primitive/segment, run

make check

If make check target is successful, developer is good to commit the code to primitive/segment's git repo.

make check target

• runs terraform commands to lint,validate and plan terraform code.
• runs conftests. conftests make sure policy checks are successful.
• runs terratest. This is integration test suit.
• runs opa tests

Requirements

Name	Version
terraform	<= 1.5.5
azurerm	~> 3.77

Providers

No providers.

Modules

Name	Source	Version
resource_names	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 1.0
resource_group	terraform.registry.launch.nttdata.com/module_primitive/resource_group/azurerm	~> 1.0
network	terraform.registry.launch.nttdata.com/module_primitive/virtual_network/azurerm	~> 1.0
network_security_group	terraform.registry.launch.nttdata.com/module_primitive/network_security_group/azurerm	~> 1.0
network_security_group_subnet_asscoation	terraform.registry.launch.nttdata.com/module_primitive/nsg_subnet_association/azurerm	~> 1.0
route_table	terraform.registry.launch.nttdata.com/module_primitive/route_table/azurerm	~> 1.0
route_table_rules	terraform.registry.launch.nttdata.com/module_primitive/route/azurerm	~> 1.0
route_table_subnet_asscoation	terraform.registry.launch.nttdata.com/module_primitive/routetable_subnet_association/azurerm	~> 1.0

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
resource_names_map	A map of key to resource_name that will be used by tf-launch-module_library-resource_name to generate resource names	map(object({ name = string max_length = optional(number, 60) region = optional(string, "eastus2") }))	{}	no
instance_env	Number that represents the instance of the environment.	number	0	no
instance_resource	Number that represents the instance of the resource.	number	0	no
logical_product_family	(Required) Name of the product family for which the resource is created. Example: org_name, department_name.	string	"launch"	no
logical_product_service	(Required) Name of the product service for which the resource is created. For example, backend, frontend, middleware etc.	string	"network"	no
class_env	(Required) Environment where resource is going to be deployed. For example. dev, qa, uat	string	"dev"	no
location	Azure region to use	string	n/a	yes
use_for_each	Use for_each instead of count to create multiple resource instances.	bool	n/a	yes
address_space	The address space that is used by the virtual network.	list(string)	[ "10.0.0.0/16" ]	no
bgp_community	(Optional) The BGP community attribute in format <as-number>:<community-value>.	string	null	no
ddos_protection_plan	The set of DDoS protection plan configuration	object({ enable = bool id = string })	null	no
dns_servers	The DNS servers to be used with vNet.	list(string)	[]	no
subnet_map	A map of subnet configuration. The configuration contains subnet specific attributes, network security group and route table specific attributes.	map(object({ subnet_prefixes = list(string) subnet_enforce_private_link_service_network_policies = bool subnet_enforce_private_link_endpoint_network_policies = bool subnet_service_endpoints = list(string) subnet_delegation = map(map(any)) route_table = object({ routes = list(object({ name = string address_prefix = string next_hop_type = string next_hop_in_ip_address = optional(string) })) }) network_security_group = object({ security_rules = list(object({ name = string protocol = string access = string priority = number direction = string description = optional(string) source_port_range = optional(string) source_port_ranges = optional(list(string)) destination_port_range = optional(string) destination_port_ranges = optional(list(string)) source_address_prefix = optional(string) source_address_prefixes = optional(list(string)) source_application_security_group_ids = optional(list(string)) destination_address_prefix = optional(string) destination_address_prefixes = optional(list(string)) destination_application_security_group_ids = optional(list(string)) })) }) }))	null	no
tracing_tags_enabled	Whether enable tracing tags that generated by BridgeCrew Yor.	bool	false	no
tracing_tags_prefix	Default prefix for generated tracing tags	string	"avm_"	no
vnet_tags	The tags to associate with your network and subnets.	map(string)	{}	no

Outputs

Name	Description
resource_group_id	resource group id
resource_group_name	resource group name
vnet_address_space	The address space of the newly created vNet
vnet_guid	The GUID of the newly created vNet
vnet_id	The id of the newly created vNet
vnet_location	The location of the newly created vNet
vnet_name	The Name of the newly created vNet
vnet_subnets	The ids of subnets created inside the newly created vNet
vnet_subnets_name_id	Can be queried subnet-id by subnet name by using lookup(module.vnet.vnet_subnets_name_id, subnet1)
network_security_group_ids	value of the network security group id.
route_table_ids	The Route Table ID.
route_table_names	The Route Table Name.
route_table_rules	The Route ids.